docs(xet): update broken xet-core links after repo re-org#2477
Merged
Conversation
The xet-core repository was reorganized: the per-crate top-level directories (cas_types, cas_client, mdb_shard, merklehash, deduplication, data, hf_xet_thin_wasm, cas_object) were merged into a smaller set of larger crates (xet_client, xet_core_structures, xet_data, wasm/hf_xet_thin_wasm). Update all references in docs/xet/ to point at the new paths, and shift the line ranges in hashing.md to the corresponding code in the new locations.
|
The docs for this PR live here. All of your documentation changes will be reflected on that endpoint. The docs are available until 30 days after the last update. |
assafvayner
marked this pull request as ready for review
May 14, 2026 21:38
julien-c
approved these changes
May 15, 2026
pcuenca
approved these changes
May 15, 2026
The four "reference implementation" links in hashing.md include line anchors (#L...). Pin them to xet-core commit c3c726b so the line numbers don't drift as upstream code changes.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
The
xet-corerepository was reorganized: the per-crate top-level directories (cas_types,cas_client,mdb_shard,merklehash,deduplication,data,hf_xet_thin_wasm,cas_object) were merged into a smaller set of larger crates (xet_client,xet_core_structures,xet_data,wasm/hf_xet_thin_wasm). All the cross-repo links fromdocs/xet/to those old paths now 404.This PR:
docs/xet/to point at the new paths.hashing.mdto xet-core commitc3c726bso the line numbers don't drift as upstream code changes. Directory and whole-file links stay onmainsince they don't suffer from line drift.Path mapping applied:
cas_types/xet_client/src/cas_types/cas_client/xet_client/src/cas_client/mdb_shard/xet_core_structures/src/metadata_shard/deduplication/xet_data/src/deduplication/merklehash/xet_core_structures/src/merklehash/data/xet_data/cas_object/src/byte_grouping/xet_core_structures/src/xorb_object/byte_grouping/hf_xet_thin_wasm/wasm/hf_xet_thin_wasm/Line ranges in
hashing.mdwere re-anchored against the pinned commit so each "reference implementation" link still points at the matching code:data_hash.rscompute_data_hash:L308-L311→L310-L313aggregated_hashes.rsinternal-node merge (merged_hash_of_sequence):L103-L109→L123-L136aggregated_hashes.rsfile-hash entry point (file_hash):L123-L125→L191-L195chunk_verification.rs:L4-L16is still correct after the moveFiles touched:
docs/xet/index.md,docs/xet/hashing.md,docs/xet/xorb.md.Test plan
hashing.mdhighlight the intended functions (compute_data_hash,merged_hash_of_sequence,file_hash,range_hash_from_chunks).